home *** CD-ROM | disk | FTP | other *** search
Text File | 1994-07-28 | 87.2 KB | 4,057 lines
\hy-9{0}{ } \hy-5{2}{Manual for Tex2RTF 1.40: A LaTeX to RTF and HTML converter} \hy-6{3}{Julian Smart Artificial Intelligence Applications Institute University of Edinburgh EH1 1HN} April 1994 \hy-5{1}{ %s } \hy-6{4}{Copyright notice} \hy-6{6}{Introduction} \hy-6{155}{Hypertext features} \hy-6{162}{Special sections} \hy-6{183}{Running Tex2RTF} \hy-6{237}{Tex2RTF for non-LaTeX users} \hy-6{259}{Macro reference} \hy-6{739}{Bugs and troubleshooting} \hy-6{778}{References} \hy-6{790}{Glossary} \hy-10{5}{Copyright notice} Copyright (c) 1994 Julian Smart. Permission to use, copy, modify, and distribute this software and its documentation for any purpose is hereby granted without fee, provided that the above copyright notice, author statement and this permission notice appear in all copies of this software and related documentation. THE SOFTWARE IS PROVIDED ``AS-IS'' AND WITHOUT WARRANTY OF ANY KIND, EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL JULIAN SMART OR THE ARTIFICIAL INTELLIGENCE APPLICATIONS INSTITUTE OR UNIVERSITY OF EDINBURGH BE LIABLE FOR ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. \hy-10{7}{Introduction} This document describes a utility for converting \hy-13{8}{LaTeX} files into several other formats. Only a subset of LaTeX can be processed by this utility, especially since the target document language will never perfectly match LaTeX. Whether the quality of the results is good enough will depend upon the application and your own expectations. Tex2RTF is heavily biased towards making on-line, hypertext versions of LaTeX documents, but the \hy-13{9}{RTF} converter can be used for normal, linear documents too. The latest version of Tex2RTF can be accessed by anonymous ftp from: \hy-14{10}{skye.aiai.ed.ac.uk (192.41.104.6) } in the directory /pub/tex2rtf. It is available in SPARC Open Look and Windows 3.1 versions. Tex2RTF was developed using the free Open Look, Motif and Windows 3.1 C++ class library \hy-13{11}{wxWindows}, also available from the above FTP site in the /pub/wxwin/beta directory. \hy-8{12}{Status of Tex2RTF} \hy-8{17}{Why use LaTeX?} \hy-8{21}{Help versus the printed page} \hy-8{26}{Output Formats} \hy-8{31}{What compromises must I make?} \hy-8{49}{Changes to LaTeX syntax} \hy-8{78}{Tex2RTF change log} \hy-10{156}{Hypertext features} LaTeX is inherently suitable for specifying hypertext documents since it encourages description of the logical structure of a document using section commands. Therefore, a LaTeX document is automatically a hypertext document, without any further editing. For Windows Help, a single RTF file is generated with topics corresponding to sections. A top level contents page shows each chapter or top-level section, and each chapter or section ends with a list of further sections or subsections. Tex2RTF outputs help files that may be read linearly using the << and >> buttons. Similarly, a single wxHelp XLP file is generated. For HTML, a different file is generated for each section, since the XMOSAIC browser works best with a large number of small files. The files are named automatically based on the name of the output file, with the contents page filename being formed from the output filename with \hy-14{157}{_contents} appended to the name. This may result in the generation of several hundred files for a large LaTeX input file. To specify explicit jumps around a hypertext file, the \hy-13{158}{helpref} macro is used. The first argument is the text to be displayed at the point of reference, which will be highlighted in a hypertext file to allow jumping to a reference. The second argument is the reference label (there should be a corresponding \hy-13{159}{label} command in the file, following a section or figure). To use extra Tex2RTF features in proper LaTeX, such as \hy-8{160}{helpref} and the C++ and CLIPS class reference documentation features, include the style file \hy-14{161}{texhelp.sty}. \hy-10{163}{Special sections} The treatment of bibliography, glossary and index are worth special mention. \hy-8{164}{Bibliography} \hy-8{173}{Glossary} \hy-8{178}{Index} \hy-10{184}{Running Tex2RTF} Tex2RTF may be run in a number of ways: with or without command line arguments, interactively or in batch mode, and with an optional initialisation file for specifying LaTeX macros and detailed options. Tex2RTF accepts two arguments (input and output filenames) and trailing (optional) switches. If both filenames are given, the utility will work in batch mode. Otherwise, if Tex2RTF has been compiled for GUI operation, a main window will be shown, with appropriate menu items for selecting input and output filenames, starting off the conversion process, and so on. Note that if the file \hy-14{185}{bullet.bmp} is found by Tex2RTF, this bitmap will be used as the bullet for items in \hy-7{186}{itemize} lists, for WinHelp output. Otherwise, a symbol will be inserted (linear RTF) or bold `o' will be used instead (all other formats). Syntax error reporting is fairly minimal. Unrecognised macro errors may actually be produced by an unbalanced brace or passing the wrong number of arguments to a macro, so look in the vicinity of the error for the real cause. ---------------------------------------------------------------------- Some of the syntax that is OK for true LaTeX but which trips up Tex2RTF, may be detected by the TCHECK program included in the tools directory of the Tex2RTF distribution. Some LaTeX errors may be picked up by the LACHECK program, also found in the tools directory. ---------------------------------------------------------------------- It is recommended that you run Tex2RTF twice in order to be sure of of resolving all references and including an up-to-date contents page. If importing RTF files into Word for Windows, you may need to reformat the document. The easiest way to do this is to select all text with CTRL-A, then reformat with F9. Reformat again to ensure all references are resolved. For the second format, respond with \hy-7{187}{Update Entire Table} to prompts. \hy-8{188}{Command line arguments} \hy-8{200}{Initialisation file syntax} \hy-8{228}{DDE commands} \hy-10{238}{Tex2RTF for non-LaTeX users} You don't need to have LaTeX installed to use Tex2RTF. You can still output RTF files to be imported into your favourite word processor, and hypertext files for on-line help. This chapter gives a very brief introduction to LaTeX. For further information, Kopka and Daly's \hy-7{239}{A Guide to LaTeX} [3] is recommended. \hy-8{240}{What is LaTeX?} \hy-8{243}{Document structure} \hy-8{250}{Command syntax} \hy-8{254}{Space} \hy-10{260}{Macro reference} The following lists macros which are recognised by the converters. Other macros not not mentioned can be assumed to be unrecognised or ignored. Each command is listed with its name, the number of arguments it takes (excluding optional arguments), and a description. Note that if the command is used as an environment (using \hy-7{261}{begin} and \hy-7{262}{end}) then the number of arguments must be either one or two. For example, the \hy-7{263}{ tabular} environment takes two arguments: a first argument for specifying the formatting, and the second argument for the body of the environment. \hy-14{264}{\begin{tabular}{|l|l|} \row{One}{Two} \row{Three}{Four} \end{tabular} } \hy-8{265}{Commands} \hy-8{731}{Accents} \hy-10{740}{Bugs and troubleshooting} \hy-8{741}{Bugs} \hy-8{753}{Troubleshooting} \hy-10{779}{References} [1] \hy-8{780}{Boggan, Scott and Fakas, David and Welinske, Joe}. 1993. \hy-7{781}{Developing on-line help for Windows. }Sams Publishing. 11711 North College, Carmel, Indiana 46032, USA. [2] \hy-8{782}{Smart, Julian}. 1993. \hy-7{783}{wxWindows 1.50 User Manual. }University of Edinburgh. Artificial Intelligence Applications Institute. 80 South Bridge, Edinburgh, EH1 1HN. [3] \hy-8{784}{Kopka, Helmut and Daly, Patrick W.} 1993. \hy-7{785}{A Guide to LaTeX. }Addison-Wesley. [4] \hy-8{786}{Robins, Gabriel}. 1987 (September). \hy-7{787}{The ISI grapher: a portable tool for displaying graphs pictorially (ISI/RS-87-196). }Technical report. University of South California. [5] \hy-8{788}{Pfeiffer, Katherine Shelly}. 1994. \hy-7{789}{Word for Windows Design Companion. }Ventana Press. \hy-10{791}{Glossary} \hy-8{792}{GUI} \hy-8{794}{HTML} \hy-8{796}{LaTeX} \hy-8{798}{Metafile} \hy-8{800}{Open Look} \hy-8{802}{RTF} \hy-8{804}{wxHelp} \hy-8{806}{wxWindows} \hy-8{808}{XView} \hy-10{13}{Status of Tex2RTF} Tex2RTF is under continual development, often following users' suggestions. From version 1.33, Tex2RTF is effectively in a second phase of development. In addition to the bare minimum of syntax and facilities for producing useable help systems or linear RTF, commands are being added to allow visually effective, even aesthetically pleasing, documentation to be produced. Examples are the \hy-7{14}{indented}, \hy-7{15}{twocollist} and \hy-7{16}{marginpar} commands; over time I hope to be able to reproduce most of the popular styles of formatting and presentation in Windows Help files, whilst allowing a reasonable equivalent to be generated in the other formats. \hy-10{18}{Why use LaTeX?} LaTeX happens to be a very convenient format if you need to produce documents (such as manuals, help facilities, up-to-date information) in both printed and on-line media. Being a language rather than a WYSIWYG system, it allows explicit specification of layout and document structure, lending itself well to hypertext applications and automatic document generation. Many people also prefer to use LaTeX for ordinary use since it encourages a logical document structure and the user is not distracted by having to perfect the appearance; many layout decisions are taken by LaTeX automatically. Although LaTeX is not as fancy as modern word processors and desk-top publishing packages, it is for many purposes quite adequate, and sometimes more flexible than its modern counterparts. The conversion utility gives LaTeX a new lease of life by allowing virtually all other wordprocessor formats to be generated from documents containing a reasonable subset of LaTeX syntax. From the same LaTeX sources, we can now generate printed manuals, Windows Help files, \hy-13{19}{wxHelp} files, RTF-compatible word processor formats such as MS Word, and \hy-13{20}{HTML} files for use in the World Wide Web. Since the conversion tool is free, as are LaTeX, HTML viewers, wxHelp and (effectively) Windows Help, there are no financial or time penalties for providing documentation in a wide range of printed and hypertext formats. \hy-10{22}{Help versus the printed page} The purist may argue, quite rightly, that on-line help systems and printed manuals have different characteristics; help windows tend to be much smaller than pages, help topics should be more stand-alone than pages in a manual, navigation methods are very different, etc. Therefore, help systems should be \hy-7{23}{based} on printed documentation but separately hand-crafted into hypertext help, preferably by an independent person or team. This might be the ideal, but many organisations or individuals simply do not have the time: on-line help wouldn't get done if the documentation effort had to be doubled. However, Tex2RTF does provide some commands to allow tailoring the docmentation to printed or on-line form, such as \hy-7{24}{helponly} and \hy-7{25}{helpignore}. An awareness of the design issues should go a long way to making the compromise a good one, so a book such as [1] is highly recommended. \hy-10{27}{Output Formats} At present the following output formats are supported: \hy-8{28}{o} RTF (Rich Text Format). This is the most well developed converter. RTF is commonly used as a document exchange format amongst Windows-based applications, and is the input for the Windows Help Compiler. Tex2RTF supports both linear documents and Windows Help hypertext format. \hy-8{29}{o} wxHelp. This is the platform-independent help system for the class library wxWindows [2]. It can display ASCII files with embedded codes for changing font styles, but no formatting is done by wxHelp. \hy-8{30}{o} HTML (Hypertext Markup Language). This an SGML-like format commonly used by documents in the World Wide Web distributed hypertext system, and formats text dynamically rather like Windows Help. \hy-10{32}{What compromises must I make?} As a LaTeX user, you need to be aware that some macros or facilities don't transfer to other formats, either because they are not supported by the target format or because the converter does not support them. Maths formatting is a good example of an unsupported feature. Sometimes LaTeX facilities must be accessed in a slightly different way to support the variety of formats, particularly hypertext formats where LaTeX references are often replaced by hypertext jumps (but must still look right in printed documentation). Tables don't transfer well to RTF (and not at all to the other formats) but an attempt is made to approximate tables so long as special row macros are used, instead of the usual end of row delimiter. Bibliographies are handled quite well since the utilities can read in \hy-14{33}{.bib} files and resolve citations. Numbers are used in citations; the references are not yet sorted alphabetically. Pictures are handled in a limited way: if the PSBOX macro package is used, an \hy-7{34}{image} macro can be used to place Encapsulated PostScript files in LaTeX, and Windows RGB-encoded bitmap files or placeable metafiles when converting to RTF. Nested file inclusion (input, include, verbatiminput), is handled, and the comment environment is supported. However, using \hy-7{35}{input} to include macro packages is not advisable. If you do this, make sure you add a line in the Tex2RTF initialisation file to ignore this file, unless it's a simple LaTeX file that conforms to Tex2RTF restrictions. The file \hy-14{36}{psbox.tex} is the only file ignored by Tex2RTF by default. Because of the way LaTeX is parsed, some syntax has to conform to a few simple rules. Macros such as \hy-7{37}{bf} and \hy-7{38}{it} need to occur immediately after a left brace, and have a block of their own, since the text within their scope is regarded as its argument. This syntax means the same thing as using \hy-7{39}{begin ... end}, which is usually a one argument macro (the argument is the text between the \hy-7{40}{begin} and \hy-7{41}{end}). See \hy-13{42}{Space}. As a Windows hypertext help writer, you don't have access to all RTF commands but you'll be able to get most of what you want. In particular, any LaTeX document you write will automatically be a hypertext document, because the converter takes advantage of the hierarchy of sections. Further jumps can be placed using the commands \hy-13{43}{label}, \hy-13{44}{helpref}, \hy-13{45}{helprefn}, and \hy-13{46}{popref}. Tex2RTF outputs help files that may be read linearly using the << and >> buttons, and an additonal Up button for ease of navigation. When writing HTML, multiple files are generated from one LaTeX file since browsing HTML works best with many small files rather than a few large ones. wxHelp files are least well supported since there is no formatting support, only font style, sizes and colours. Still, some hypertext help support on UNIX/X platforms is better than none. The class library wxWindows may be extended in future to allow using a better help viewer, such as \hy-7{47}{xmosaic}. Of course there is nothing to stop xmosaic being used as a help system, but it won't be integrated with wxWindows programs as wxHelp is. Sometimes you will use a local macro package that is unrecognised by the converters. In this case, you may define a custom macro file where macros are defined in terms of supported LaTeX commands and text. Even if the result is not the same as in LaTeX, you can probably end up with something adequate, and at least avoid undefined macro errors. See \hy-13{48}{Initialisation file syntax} for further information. \hy-10{50}{Changes to LaTeX syntax} Here are the conventions you need to observe to satisfy the Tex2RTF parser. ---------------------------------------------------------------------- Some of the syntax that is OK for true LaTeX but which trips up Tex2RTF, may be detected by the TCHECK program included in the tools directory of the Tex2RTF distribution. ---------------------------------------------------------------------- \hy-8{51}{Space} \hy-8{56}{Command arguments} \hy-8{62}{Avoid the setlength macro} \hy-8{66}{Units} \hy-8{70}{Labels} \hy-8{73}{Tables} \hy-10{79}{Tex2RTF change log} Changes in version 1.40: \hy-8{80}{o} Added \hy-8{81}{generateHPJ} option for generating the .HPJ WinHelp project file \hy-8{82}{o} Added support for DDE via a small command set Changes in version 1.39: \hy-8{83}{o} Option for using Word's INCLUDEPICTURE or IMPORT field, since the method that works for Works, doesn't work for Word! See \hy-8{84}{bitmapMethod} in the settings section. Changes in version 1.37-1.38: \hy-8{85}{o} Improved bibliography reading and cured some minor bugs \hy-8{86}{o} Added \ss German sharp s \hy-8{87}{o} Added rudimentary \special command (simply copies the argument to the output) \hy-8{88}{o} Added missing '.' in subsubsection reference \hy-8{89}{o} Added primitive internationalisation support with contentsName, tablesName etc. Changes in version 1.36: \hy-8{90}{o} All HTML special characters now correctly delimited by a semicolon. \hy-8{91}{o} Cured HTML section-duplicating bug I introduced in 1.35. \hy-8{92}{o} Cured too much spacing after sections in RTF, introduced in 1.35. Changes in version 1.35: \hy-8{93}{o} Added TCHECK tool, to help track down common Tex2RTF syntax problems. \hy-8{94}{o} Included Kresten Thorup's LACHECK LaTeX checking tool with DOS executable. \hy-8{95}{o} Now ignores \@ command. \hy-8{96}{o} Table of contents now includes numbered subsubsections. Changes in version 1.34: \hy-8{97}{o} Added \hy-7{98}{multicolumn} `support' to stop RTF readers crashing. \hy-8{99}{o} Added \hy-7{100}{useWord, defaultColumnWidth, compatibility} options to .ini file. \hy-8{101}{o} \hy-7{102}{comment} environment now doesn't complain about unknown syntax. \hy-8{103}{o} Added \hy-7{104}{toocomplex} environment that treats its contents as verbatim in output, treated as normal output in true LaTeX. \hy-8{105}{o} End-of-line comments allowed in in .ini files, using semicolon, percent or hash characters to denote a comment. \hy-8{106}{o} For linear RTF, Word for Windows support for \hy-7{107}{printindex}, \hy-7{108}{index}, \hy-7{109}{pageref}, \hy-7{110}{listoftables}, \hy-7{111}{listoffigures}, contents page. \hy-8{112}{o} Added RTF support for various symbols. \hy-8{113}{o} Added colour support, with \hy-7{114}{definecolour, fcol} and \hy-7{115}{bcol} commands. \hy-8{116}{o} Fixed some bugs: page numbering problems, macros deleted after first pass. Changes in version 1.33: \hy-8{117}{o} Added -charset command-line switch. \hy-8{118}{o} Added \hy-7{119}{itemsep, twocolumn, onecolumn, setfooter, setheader, pagestyle, pagenumbering, thechapter, thesection, thepage, thebibliography, bibitem} commands. \hy-8{120}{o} New environment called \hy-7{121}{twocollist} for making two-column lists, with formatting optimized for target file format. \hy-8{122}{o} New \hy-7{123}{indented} environment for controlling indentation. \hy-8{124}{o} List indentation and bulleting improved. \hy-8{125}{o} Added commands \hy-7{126}{normalbox, normalboxd} for putting borders around text. \hy-8{127}{o} Many options can now be specified in the .ini file along with custom macros. \hy-8{128}{o} Cured bug that put too much vertical space after some commands. \hy-8{129}{o} Improved table formatting. \hy-8{130}{o} Optional `Up' button in WinHelp files for easier navigation. \hy-8{131}{o} Verbatim lines followed by \hy-7{132}{par} in RTF, to improve WinHelp wrapping. \hy-8{133}{o} Conversion may now be aborted under Windows by attempting to close the application. \hy-8{134}{o} Added conditional output for all formats: \hy-7{135}{latexignore, latexonly, rtfignore, rtfonly, winhelpignore, winhelponly, htmlignore, htmlonly, xlpignore, xlponly.} \hy-8{136}{o} HTML generator can now add Contents, Up, << and >> buttons (text or bitmap) to each page except titlepage. Changes in version 1.32: \hy-8{137}{o} \hy-7{138}{footnote} command now supported in WinHelp RTF, and \hy-7{139}{footnotepopup} added. Changes in version 1.31: \hy-8{140}{o} \hy-7{141}{footnote} command now supported, in linear RTF only. \hy-8{142}{o} Added -bufsize option, for converting large documents. Changes in version 1.30: \hy-8{143}{o} \hy-7{144}{image} command now scales metafiles (but not bitmaps). \hy-8{145}{o} Fixed macro loading bug, now informs the user of the found macro filename. \hy-8{146}{o} Now supports paragraph and subparagraph commands. \hy-8{147}{o} Support for some accents added. \hy-8{148}{o} \hy-7{149}{verb} command now supported. \hy-8{150}{o} Bug in subsubsection handling fixed. \hy-8{151}{o} Can save conversion log in a text file. Changes in version 1.22: \hy-8{152}{o} More informative, warns against use of some commands. \hy-8{153}{o} Added compile-time support for non-GUI environments (such as plain UNIX). \hy-8{154}{o} Improved HTML support. \hy-10{165}{Bibliography} Tex2RTF recognises standard LaTeX bibliography files (usually with \hy-14{166}{.bib} extension) and resolves citations. The \hy-13{167}{bibliography} command reads the given \hy-14{168}{.bib} file and includes a list of references at that point in the input. Only numbered, unsorted references are catered for at the moment, with no variation in bibliography style. A \hy-8{169}{References} heading is placed in the contents section. Note that Tex2RTF must be run twice to ensure the citations are resolved properly. Tex2RTF can also cope with the \hy-7{170}{thebibliography} environment, with \hy-7{171}{bibitem} commands, so long as the text following the first \hy-7{172}{bibitem} argument is enclosed in braces as if it were a second argument. \hy-10{174}{Glossary} Glossaries are formatted according to the following scheme. The \hy-13{175}{helpglossary} environment is used together with the \hy-13{176}{gloss} command for glossary entries. In LaTeX this is interpreted as a description list, and each glossary entry is an item. In on-line help, each glossary entry is a section. A labelled glossary entry command may be referenced by \hy-13{177}{popref} to provide a quick popup explanation of a term. \hy-10{179}{Index} The explicit index is assumed to be redundant in on-line help, since search facilities are provided. Therefore the \hy-7{180}{printindex} command does nothing in on-line versions. In linear RTF an index field is added, and \hy-13{181}{index} marks words for inserting in the index. In Windows Help, all section headings and C++ function names are treated as keywords. A keyword may be ambiguous, that is, refer to more than one section in the help file. This automatic indexing may not always be adequate, so the LaTeX \hy-13{182}{index} command may be used to add keywords. In wxHelp, all section headings are indexed. \hy-10{189}{Command line arguments} These are the optional arguments you may give Tex2RTF on the command line. \hy-8{190}{-bufsize} Specifies buffer size in K (default 60 under Windows, 500 under UNIX). Large files (particularly large verbatim environments) may require a large buffer size, equal to the largest argument of a LaTeX command. Note that this value may not be larger than 64 under Windows. \hy-8{191}{-html} Specifies HTML (World Wide Web) output. \hy-8{192}{-interactive} Forces interactive mode even if both filenames are given. \hy-8{193}{-charset charset} Specifies a character set for RTF production. This can be one of ansi, mac, pc, and pca. The default is ansi. \hy-8{194}{-macros filename} Specifies a file for the custom macro file -- see \hy-13{195}{Macro not found error}. \hy-8{196}{-rtf} Specifies linear RTF output. \hy-8{197}{-sync} Forces synchronous mode (no yielding to other processes) -- usually use this in non-interactive mode. \hy-8{198}{-twice} Tells Tex2RTF to run the conversion twice to ensure all references and citations are resolved and the contents page included. \hy-8{199}{-winhelp} Specifies Windows Help RTF output. \hy-10{201}{Initialisation file syntax} The initialisation file contains further detailed options for customising Tex2RTF's behaviour. A file may be specified with the \hy-8{202}{-macros} command line switch, otherwise Tex2RTF looks for the file \hy-14{203}{tex2rtf.ini} in the working directory or input file directory. The file may comprise macro definitions or option settings. The syntax for a macro definition is: \hy-14{204}{\name [number of args] {...LaTeX code...} } For example: \hy-14{205}{\crazy [2]{{\bf #2} is crazy but #1 is not} \something [0]{} \julian [0]{Julian Smart} } The syntax for an option setting is: \hy-14{206}{name = value } or \hy-14{207}{name = "value" } For example: \hy-14{208}{conversionMode = RTF runTwice = true titleFontSize = 12 authorFontSize = 10 headerRule = yes footerRule = yes } Options expecting boolean values accept \hy-7{209}{1, 0, true, false, yes, no} in any combination of upper or lower case. End-of-line comments are allowed in an initialisation file, using the hash, semicolon or percent signs to denote the start of a comment, which runs until the end of the line. \hy-8{210}{Tex2RTF options} \hy-10{229}{DDE commands} A Windows program can hold a conversation with Tex2RTF using DDE. The Tex2RTF server name is ``TEX2RTF'', and the topic name to use is also ``TEX2RTF''. Tex2RTF functionality is accessed using the DDE \hy-8{230}{Execute} message. The \hy-8{231}{Execute} data should consist of a command name and possibly one argument, e.g. \hy-14{232}{INPUT c:\docs\mine.tex } If the command is not recognised, a standard TEX2RTF.INI option is assumed. The \hy-8{233}{Request} DDE message can be used to query the return status of an \hy-8{234}{Execute} command, and will be one of \hy-8{235}{OK} (no error), \hy-8{236}{CONVERSION ERROR}, or a more specific error string. The following DDE commands may be used: Command Description EXIT Takes no argument, and exits Tex2RTF. GO Takes no argument, and initiates the conversion. INPUT Takes a file name as the argument, and sets the input file to be this name. MINIMIZE Takes no argument, and minimizes Tex2RTF. OUTPUT Takes a file name as the argument, and sets the input file to be this name. RESTORE The same as SHOW. SHOW Takes no argument, and unminimizes Tex2RTF. \hy-10{241}{What is LaTeX?} LaTeX is a macro package built on top of the typesetting package, TeX. TeX was written by Donald Knuth in the 1970s, and Leslie Lamport wrote LaTeX as a higher-level, easier way to write TeX. TeX was quite advanced for its day, and is still used (particularly by academics) because of its free availability and its flexibility in typesetting maths and other symbols. It's more like a programming language than a word processor, with embedded commands prefixed by a backslash and block structure. Like programs, TeX documents are processed by a `compiler', outputting a .dvi file, which is a device independent file which can be read by many converters for output onto physical devices, such as screens and printers. A reason for its longevity is the ability to add facilities to TeX, using macro packages that define new commands. LaTeX is the most popular way to write TeX. Although WYSIWYG word processors and DTP packages are outstripping LaTeX, the increasing interest in hypertext and mark-up languages makes LaTeX relevant as a similar language to SGML documents (such as World Wide Web HTML files). Also, languages such as LaTeX (and Rich Text Format, which it resembles in many ways) are \hy-7{242}{complementary} to WYSIWYG packages. These languages allow automatic production and translation of documents, where manual mark-up is impractical or undesirable. Since the source code of TeX and LaTeX is in the public domain, there are many free and commercial implementations of LaTeX for almost every computer in existance. Of PC implementations, EmTeX is arguably the best and most complete. You can download it from various FTP sites. If you don't want to use LaTeX itself, you may wish to use a program called lacheck to check your documents before using Tex2RTF, since it catches some mistakes that Tex2RTF doesn't. \hy-10{244}{Document structure} Here is a sample of a typical LaTeX document: \hy-14{245}{\documentstyle[a4,texhelp]{report} \title{A title} \author{Julian Smart} \date{October 1993} \begin{document} \maketitle \chapter{Introduction} ... \section{A section} ... \end{document} } The first line is always a \hy-7{246}{documentstyle} command. The square brackets enclose optional \hy-7{247}{style} files (suffix .sty) that alter the appearance of the document or provide new commands, and the curly brackets enclose the mandatory style, in this case `report'. Before the document begins properly with \hy-7{248}{\begin{document}}, you can write various commands that have an effect on the appearance of the document or define title page information. The \hy-7{249}{maketitle} command writes the title page using information defined previously (title, author, date). A report has chapters, which are divided into sections, and can be further divided into subsections and subsubsections. To start a new section, you write the appropriate section command with the section heading; there is no specific end section command, since a new section heading or the end of the document will indicate the end of the previous section. An article is divided into sections, subsections and subsubsections, but has no chapters. This is so an article can be included in a report as a chapter. Tex2RTF is written to deal with reports best, so stick with the report style if you can. \hy-10{251}{Command syntax} There are several kinds of commands in LaTeX. Most involve a keyword prefixed with a backslash. Here are some examples: \hy-14{252}{\titlepage \centerline{This is a centred line} \begin{center} This is a centred paragraph \end{center} {\bf This is bold font} } The first example has no arguments. The second has one argument. The third example is an \hy-7{253}{environment} which uses the begin and end keywords instead of a pair of braces to enclose an argument (usually one). The fourth is an example of using a command within a pair of braces: the command applies to the scope within the braces. Tex2RTF treats this form as if it were a command with one argument, with the right brace delimiting the argument. In this case, the command must immediately follow a left brace as shown. Commands may be nested, but not overlapped. \hy-10{255}{Space} In LaTeX, white space is mostly ignored, line breaks make no difference. However, LaTeX interprets two successive newlines (a blank line) as denoting a paragraph break. You may also use the \hy-7{256}{par} command to end a paragraph. \hy-6{257}{\hy-7{258}{To be continued!}} \hy-10{266}{Commands} \hy-8{267}{abstract:1} \hy-8{269}{addcontentsline:3} \hy-8{271}{author:1} \hy-8{274}{backslash:0} \hy-8{276}{bcol:2} \hy-8{280}{bf:1} \hy-8{282}{bibitem:2} \hy-8{287}{bibliographystyle:1} \hy-8{289}{bibliography:0} \hy-8{292}{caption:1} \hy-8{296}{cdots:0} \hy-8{298}{centerline:1} \hy-8{300}{center:1} \hy-8{302}{cextract:0} \hy-8{304}{chapter*:1} \hy-8{306}{chapter:1} \hy-8{308}{chapterheading:1} \hy-8{312}{cinsert:0} \hy-8{314}{cite:1} \hy-8{316}{class:1} \hy-8{318}{clipsfunc:3} \hy-8{320}{comment:1} \hy-8{323}{copyright:0} \hy-8{325}{cparam:2} \hy-8{328}{date:1} \hy-8{331}{definecolour:4} \hy-8{337}{description:1} \hy-8{340}{documentstyle:1} \hy-8{345}{document:1} \hy-8{347}{em:1} \hy-8{349}{enumerate:1} \hy-8{352}{fcol:2} \hy-8{357}{figure:1} \hy-8{359}{flushleft:1} \hy-8{361}{flushright:1} \hy-8{363}{footnote:1} \hy-8{367}{footnotepopup:2} \hy-8{372}{functionsection:1} \hy-8{375}{func:3} \hy-8{378}{gloss:1} \hy-8{386}{helpglossary:1} \hy-8{389}{helpignore:1} \hy-8{391}{helponly:1} \hy-8{393}{helpinput:1} \hy-8{395}{helpfontfamily:1} \hy-8{397}{helpfontsize:1} \hy-8{399}{helpref:2} \hy-8{404}{helprefn:2} \hy-8{407}{hline:0} \hy-8{411}{hrule:0} \hy-8{414}{htmlignore:1} \hy-8{416}{htmlonly:1} \hy-8{418}{huge:1} \hy-8{420}{Huge:1} \hy-8{423}{HUGE:1} \hy-8{426}{include:1} \hy-8{428}{indented:2} \hy-8{431}{input:1} \hy-8{433}{itemize:1} \hy-8{438}{item:0} \hy-8{443}{itemsep:0} \hy-8{445}{image:2} \hy-8{454}{index:1} \hy-8{456}{it:1} \hy-8{458}{label:1} \hy-8{460}{large:1} \hy-8{462}{Large:1} \hy-8{465}{LARGE:1} \hy-8{468}{LaTeX:0} \hy-8{470}{latexignore:1} \hy-8{472}{latexonly:1} \hy-8{474}{ldots} \hy-8{476}{maketitle} \hy-8{481}{marginparwidth:1} \hy-8{483}{marginpar:1} \hy-8{487}{marginpareven:1} \hy-8{490}{marginparodd:1} \hy-8{497}{membersection:1} \hy-8{499}{member:1} \hy-8{501}{multicolumn:3} \hy-8{504}{newcommand:3} \hy-8{509}{newpage:0} \hy-8{511}{nocite:1} \hy-8{514}{noindent:0} \hy-8{517}{normalbox:1} \hy-8{521}{normalboxd:1} \hy-8{525}{normalsize:1} \hy-8{527}{onecolumn:0} \hy-8{529}{pageref:1} \hy-8{531}{pagestyle:1} \hy-8{537}{pagenumbering:1} \hy-8{544}{paragraph*} \hy-8{546}{paragraph} \hy-8{548}{param:1} \hy-8{551}{parindent:1} \hy-8{553}{parskip:1} \hy-8{556}{par:0} \hy-8{558}{printindex} \hy-8{560}{popref:2} \hy-8{564}{psboxto:2} \hy-8{567}{quote:1} \hy-8{569}{quotation:1} \hy-8{571}{ref:1} \hy-8{574}{rm:1} \hy-8{576}{row:1} \hy-8{580}{ruledrow:1} \hy-8{584}{rtfignore:1} \hy-8{586}{rtfonly:1} \hy-8{588}{rtfsp:0} \hy-8{590}{sc:1} \hy-8{592}{section*:1} \hy-8{594}{section:1} \hy-8{596}{sectionheading:1} \hy-8{599}{setfooter:6} \hy-8{609}{setheader:6} \hy-8{620}{shortcite:1} \hy-8{623}{small:1} \hy-8{625}{special:1} \hy-8{627}{ss:0} \hy-8{629}{subparagraph*:1} \hy-8{631}{subparagraph:1} \hy-8{633}{subsection*:1} \hy-8{635}{subsection:1} \hy-8{637}{subsubsection*:1} \hy-8{639}{subsubsection:1} \hy-8{641}{tabbing:1} \hy-8{643}{tableofcontents:0} \hy-8{647}{tabular:2} \hy-8{660}{TeX:0} \hy-8{662}{textwidth:1} \hy-8{665}{thebibliography:1} \hy-8{669}{title:1} \hy-8{672}{tiny:1} \hy-8{674}{today:0} \hy-8{676}{toocomplex:1} \hy-8{679}{tt:1} \hy-8{681}{typeout:1} \hy-8{683}{twocolitem:2} \hy-8{687}{twocolitemruled:2} \hy-8{691}{twocollist:1} \hy-8{700}{twocolwidtha:1} \hy-8{704}{twocolwidthb:1} \hy-8{708}{twocolumn:0} \hy-8{710}{underline:1} \hy-8{712}{verbatiminput:1} \hy-8{715}{verbatim:1} \hy-8{717}{verb} \hy-8{723}{winhelpignore:1} \hy-8{725}{winhelponly:1} \hy-8{727}{xlpignore:1} \hy-8{729}{xlponly:1} \hy-10{732}{Accents} The following LaTeX accents work for RTF production: \hy-8{733}{o} \'{a} produces a. Valid for a, e, i, o, u, A, E, I, O, U \hy-8{734}{o} \`{a} produces a. Valid for a, e, i, o, u, y, A, E, I, O, U, Y \hy-8{735}{o} \^{a} produces a. Valid for a, e, i, o, u, A, E, I, O, U \hy-8{736}{o} \~{a} produces a. Valid for a, n, o, A, N, O \hy-8{737}{o} \"{a} produces a. Valid for a, e, i, o, u, y, A, E, I, O, U, Y \hy-8{738}{o} \.{a} produces a. Valid for a, A \hy-10{742}{Bugs} \hy-8{743}{Command parsing.} If a command is used followed by inappropriate argument syntax, Tex2RTF can crash. This an occur when a command is used in an asterisk form that is only formed in the non-asterisk variety. The non-asterisk form is assumed, which makes the following asterisk trip up the parser. \hy-8{744}{Setlength.} Using the \setlength command doesn't work, since its first argument looks like a macro with the wrong number of arguments. Use an alternative form instead, e.g. \parindent 0pt instead of \setlength{parindent}{0pt}. \hy-8{745}{Newcommand bug.} Environments in a command definition confuse Tex2RTF. Use the command form instead (e.g. \flushleft{...} instead of \begin{flushleft} ... \end{flushleft}. \hy-8{746}{Bibliography.} There's no flexibility in the way references are output: I expect I'll get round to doing something better, but only if people tell me they need it! \hy-8{747}{Tables.} Tables can't handle all LaTeX syntax, and require the Tex2RTF \row commands for decent formatting. Still, it's better than it was (RTF only). \hy-8{748}{Indexes and glossaries.} Not completely supported. \hy-8{749}{Crashes.} Crashes may be due to an input file exceeding the fixed-size buffer used for converting command arguments, especially for the \hy-7{750}{verbatim} command. Use the \hy-8{751}{-bufsize} switch to increase the buffer size. \hy-8{752}{Verbatiminput.} Verbatiminput files which do not end with a blank line can trip up following commands. \hy-10{754}{Troubleshooting} Below are some common problems and possible solutions. ---------------------------------------------------------------------- Some of the syntax that is OK for true LaTeX but which trips up Tex2RTF, may be detected by the TCHECK program included in the tools directory of the Tex2RTF distribution. Some LaTeX errors may be picked up by the LACHECK program, also found in the tools directory. ---------------------------------------------------------------------- \hy-8{755}{Macro not found} \hy-8{762}{Unresolved reference} \hy-8{764}{Output crashes the RTF reader} \hy-8{768}{Erratic list indentation} \hy-8{771}{Missing figure or section reference} \hy-8{774}{Unresolved references in Word for Windows} \hy-10{793}{GUI} Graphical User Interface, such as Windows 3 or X. \hy-10{795}{HTML} Hypertext Markup Language; an SGML document type, used for providing hypertext information on the World Wide Web, a distributed hypertext system on the Internet. \hy-10{797}{LaTeX} A typesetting language implemented as a set of TeX macros. It is distinguished for allowing specification of the document structure, whilst taking care of most layout concerns. It represents the opposite end of the spectrum from WYSIWYG word processors. \hy-10{799}{Metafile} Microsoft Windows-specific object which may contain a restricted set of GDI primitives. It is device independent, since it may be scaled without losing precision, unlike a bitmap. A metafile may exist in a file or in memory. wxWindows implements enough metafile functionality to use it to pass graphics to other applications via the clipboard. A placeable metafile is a metafile with a 22-byte header which can be imported into several Windows applications, and is a format used by the Microsoft help compiler. \hy-10{801}{Open Look} A specification for a GUI `look and feel', initiated by Sun Microsystems. XView is one toolkit for writing Open Look applications under X, and wxWindows sits on top of XView. \hy-10{803}{RTF} Rich Text Format: an interchange format for word processor files, used for importing and exporting formatted documents, and as the input to the Windows Help compiler. \hy-10{805}{wxHelp} wxHelp is the hypertext help facility used to provide on-line documentation for UNIX-based wxWindows applications. Under Windows 3.1, Windows Help is used instead. \hy-10{807}{wxWindows} wxWindows is a free C++ toolkit for writing applications that are portable across several platforms. Currently these are Motif, Open Look, Windows 3.1 and Windows NT. \hy-10{809}{XView} An X toolkit supplied by Sun Microsystems, initially just for porting SunView applications to X, but which has become a popular toolkit in its own right due to its simplicity of use. XView implements Sun's Open Look `look and feel' for X, but is not the only toolkit to do so. \hy-10{52}{Space} Tex2RTF attempts to insert spaces where LaTeX assumes whitespace. However, for the benefit of RTF conversion, you need to use the \hy-7{53}{ \rtfsp} macro where a command or brace within a paragraph begins or ends with a macro. For example: \hy-14{54}{Within a paragraph, you need to be careful about commands that begin \rtfsp {\it at the start} of a line. } As normal with LaTeX, two newlines represents a paragraph break, although \hy-13{55}{par} can also be used at the end of a paragraph. You need to have a blank line between section and some environment commands and the first paragraph or your document will look rather weird, e.g. headings running into paragraphs. wxHelp is more fussy than LaTeX or RTF: you need to use percent characters at line ends liberally to eliminate newlines after commands on single lines. \hy-10{57}{Command arguments} Commands that have one or more arguments can be used in the following three ways: \hy-14{58}{\bf{Some text.} \begin{bf} Some text. \end{bf} {\bf Some text.} } The first method is a normal LaTeX command. The second method is called an \hy-7{59}{environment}; LaTeX has specific environments that do not always correspond to normal commands, but Tex2RTF recognizes environments and normal commands interchangeably, so long as the command has no more than two arguments. With the third method, it is important that the command has its own pair of braces, and that the command immediately follows the first brace. Otherwise, the parser cannot parse the argument(s) properly. With multiple arguments, each should be enclosed in braces. Optional arguments are specified using square brackets or parentheses. The braces that start command arguments must not be seperated from the other arguments by whitespace. For example, the following produces an error: \hy-14{60}{\image{5cm;0cm} {picture.eps} } and should be replaced by \hy-14{61}{\image{5cm;0cm}{picture.eps} } \hy-10{63}{Avoid the setlength macro} Using the \setlength command doesn't work, since its first argument looks like a macro with the wrong number of arguments. Use an alternative form instead, e.g. \hy-14{64}{\parindent 0pt } instead of \hy-14{65}{\setlength{\parindent}{0pt} } \hy-10{67}{Units} Only a subset of LaTeX units may be used for specifying dimensions. Valid units are \hy-7{68}{pt, mm, cm} and \hy-7{69}{in}. Units should usually be specified for dimensions or the results may be unexpected. \hy-10{71}{Labels} The \hy-7{72}{label} command may be used for sections and figure captions, but must come immediately after the section or caption commands with no intervening whitespace. \hy-10{74}{Tables} For best layout, table rows should be enclosed in a \hy-7{75}{row} or \hy-7{76}{ruledrow} command, since Tex2RTF can't cope with parsing the LaTeX tabular syntax unaided. However, if you really don't want to go through LaTeX files inserting new syntax, set the \hy-8{77}{compatibility} flag to TRUE in your tex2rtf.ini file. In this mode, Tex2RTF tries to make the best of a bad job, but the results won't be optimal (e.g., no table borders). Without this flag set, normal LaTeX tables can crash RTF readers such as Word for Windows. \hy-10{211}{Tex2RTF options} These are the allowable options in an initialisation file. \hy-8{212}{General options} \hy-8{217}{Presentation options} \hy-8{219}{RTF/WinHelp options} \hy-8{226}{HTML options} \hy-10{268}{abstract:1} This standard LaTeX environment prepares an abstract page, and is treated as an ordinary chapter or section in on-line help. \hy-10{270}{addcontentsline:3} Adds a chapter title to the contents page. Linear RTF. Rarely required. \hy-10{272}{author:1} Defines the author, for output when \hy-7{273}{maketitle} is used. \hy-10{275}{backslash:0} Outputs a backslash in math mode (should be enclosed by two dollar symbols). \hy-10{277}{bcol:2} Sets the background colour for a block of text (RTF only). Has no known effect in the RTF readers currently tried (Word for Window and Windows Help). See also \hy-13{278}{definecolour}, \hy-13{279}{fcol}. \hy-10{281}{bf:1} Specifies bold font. \hy-10{283}{bibitem:2} For parsing convenience, \hy-7{284}{bibitem} requires two arguments: a cite key and item. LaTeX syntax permits writing this as if it were two arguments, even though it is in fact only one. This command is used within a \hy-13{285}{thebibliography} environment. The preferred method is to store references in .bib files and use the \hy-13{286}{bibliography} command to generate a bibliography section automatically. \hy-10{288}{bibliographystyle:1} Currently doesn't affect the style of bibliography, but probably will in the future. \hy-10{290}{bibliography:0} Includes the bibliography at this point in the document. See the section on \hy-13{291}{bibliographies}. \hy-10{293}{caption:1} Specifies a caption (within a \hy-13{294}{figure} environment). This may be followed immediately by a \hy-13{295}{label} command. \hy-10{297}{cdots:0} Outputs three dots. \hy-10{299}{centerline:1} Centres (or centers!) a line of text. \hy-10{301}{center:1} Centres a block of text. \hy-10{303}{cextract:0} Prints a C++ extraction operator (>>). \hy-10{305}{chapter*:1} Outputs a chapter heading with no contents entry. \hy-10{307}{chapter:1} Outputs a chapter heading. \hy-10{309}{chapterheading:1} Like \hy-13{310}{chapter}, but does not increment the chapter number and does not print a chapter number in the printed documentation contents page, or in the chapter heading. Used to implement \hy-13{311}{glossaries} and other sections that are not real chapters. \hy-10{313}{cinsert:0} Prints a C++ insertion operator (<<). \hy-10{315}{cite:1} Cite a reference. The argument is a reference key as defined in a LaTeX .bib file. \hy-10{317}{class:1} Outputs the argument, an index entry (LaTeX only) and a keyword entry (WinHelp only). Used in class reference documentation. \hy-10{319}{clipsfunc:3} Formats a CLIPS function, given the return value, function name, and arguments. \hy-10{321}{comment:1} An environment that allows large comments in LaTeX files: the argument is ignored in all formats. Useful for commenting out parts of files that cannot be handled by LaTeX, such as the picture environment. See also \hy-13{322}{toocomplex}. \hy-10{324}{copyright:0} Outputs the copyright symbol. \hy-10{326}{cparam:2} Formats a CLIPS type and argument. Used within the third argument of a \hy-13{327}{clipsfunc} command. \hy-10{329}{date:1} Specifies the date of a document; only output by \hy-13{330}{maketitle}. \hy-10{332}{definecolour:4} Defines a new colour that can be used in the document (RTF only). This command can also be spelt \hy-7{333}{definecolor}. The first argument is the lower-case name of the colour, and the following three arguments specify the red, green and blue intensities, in the range 0 to 255. The default colours are equivalent to the following definitions: \hy-14{334}{\definecolour{black}{0}{0}{0} \definecolour{cyan}{0}{255}{255} \definecolour{green}{0}{255}{0} \definecolour{magenta}{255}{0}{255} \definecolour{red}{255}{0}{0} \definecolour{yellow}{255}{255}{0} \definecolour{white}{255}{255}{255} } To use colours in a document, use the \hy-13{335}{fcol} and \hy-13{336}{bcol} commands. Note that a document that defines its own colours should be converted twice within the same Tex2RTF session. \hy-10{338}{description:1} A list environment, where each \hy-13{339}{item} command must be followed by optional square-bracketed text which will be highlighted. \hy-10{341}{documentstyle:1} Specifies the main style (report, article etc.) and, optionally, style files such as \hy-14{342}{texhelp.sty}. A report has \hy-13{343}{chapters}, while an article's top-level sections are specified using \hy-13{344}{section}. \hy-10{346}{document:1} This environment should enclose the body of a document. \hy-10{348}{em:1} Emphasizes text (italic in RTF). \hy-10{350}{enumerate:1} Enumerate list environment: numbers the \hy-13{351}{items}. \hy-10{353}{fcol:2} Sets the foreground colour for a block of text (RTF only). For example: \hy-14{354}{This sentence is brightened up by some \fcol{red}{red text}. } gives: This sentence is brightened up by some . See also \hy-13{355}{definecolour}, \hy-13{356}{bcol}. \hy-10{358}{figure:1} A figure enviroment: does nothin in RTF. \hy-10{360}{flushleft:1} Flushes the given text to the left margin. \hy-10{362}{flushright:1} Flushes the given text to the right margin. \hy-10{364}{footnote:1} In linear RTF, a footnote is created. Whether this appears at the end of the section or the bottom of the page appears to depend on the current document style, at least for MS Word 6.0 for Windows. The default seems to be to put the footnotes at the end of the section, which is probably not the best assumption. In WinHelp RTF, a bracketed number is generated for the footnote and the footnote becomes a popup topic. It is probably preferable to change footnote commands to \hy-13{365}{footnotepopup}, or \hy-13{366}{popref} references to glossary entries. This command is not supported for formats other than LaTeX, linear RTF and WinHelp RTF. \hy-10{368}{footnotepopup:2} In linear RTF, a footnote is created following the first argument, as with \hy-13{369}{footnote}. In WinHelp RTF, a the first argument is highlighted and becomes a popup reference to the second argument. See also \hy-13{370}{footnote} and \hy-13{371}{popref}. This command is not supported for formats other than LaTeX, linear RTF and WinHelp RTF. \hy-10{373}{functionsection:1} Defines a subsection, adding the C++ function name to the LaTeX index or the WinHelp keyword list. Should be followed by a \hy-13{374}{func} command to specify function details. \hy-10{376}{func:3} Defines a C++ function, given the return type, function name, and parameter list. Should occur after a \hy-13{377}{functionsection} command. \hy-10{379}{gloss:1} Marks a glossary entry. In LaTeX, this is a synonym for an \hy-13{380}{item} with an optional argument, within a \hy-13{381}{description} environment, and the argument is added to the index. In Windows Help, this is identical to a \hy-13{382}{section*} in a report. If labels are associated with the glossary entries, they can be referenced by \hy-13{383}{helpref} or \hy-13{384}{popref} jumps. A glossary entry is currently the only type of destination that popref may refer to. This is an example of making a glossary in a report: \hy-14{385}{\begin{helpglossary} \gloss{API}\label{api} Application Programmer's Interface - a set of calls and classes defining how a library (in this case, wxWindows) can be used. \gloss{Canvas}\label{canvas} A canvas in XView and wxWindows is a subwindow... \gloss{DDE}\label{dde} Dynamic Data Exchange - Microsoft's interprocess communication protocol. wxWindows provides an abstraction of DDE under both Windows and UNIX. \end{helpglossary} } \hy-10{387}{helpglossary:1} An environment for making a glossary (not standard LaTeX). See \hy-13{388}{gloss} for usage. \hy-10{390}{helpignore:1} Ignores the argument in Tex2RTF generated files, but not LaTeX. \hy-10{392}{helponly:1} Only outputs the argument in Tex2RTF generated files. \hy-10{394}{helpinput:1} Only includes the given file in Tex2RTF generated files. \hy-10{396}{helpfontfamily:1} Specifies the font family for Tex2RTF generated files. The argument may be Swiss or Times. \hy-10{398}{helpfontsize:1} Specifies the font size for Tex2RTF generated files. \hy-10{400}{helpref:2} Specifies a jump to a labelled chapter, section, subsection subsubsection or figure. The first argument is text to be highlighted (mouseable in help systems) and the second is the reference label. In linear documents, the section number is given following the text, unless the \hy-13{401}{helprefn} command is used instead, where the section number is suppressed. Note that when generating HTML, the label \hy-7{402}{contents} is automatically defined, and may be referenced using \hy-7{403}{helpref}. \hy-10{405}{helprefn:2} Specifies a jump to a labelled chapter, section, subsection subsubsection or figure. The first argument is text to be highlighted (mouseable in help systems) and the second is the reference label. See \hy-13{406}{helpref} for the form where the section number is printed in linear documents. \hy-10{408}{hline:0} Within a \hy-13{409}{tabular} environment, draws a horizontal rule below the current row. Note that this does not work in RTF for the last row of a table, in which case the command \hy-13{410}{ruledrow} should be used instead. \hy-10{412}{hrule:0} Draws a horizontal line below the current paragraph. For example: \hy-14{413}{This paragraph should have a horizontal rule following it.\hrule } gives: This paragraph should have a horizontal rule following it. ------------------------------------------------------------------ \hy-10{415}{htmlignore:1} Ignores the argument in HTML. \hy-10{417}{htmlonly:1} Only outputs the argument in HTML. \hy-10{419}{huge:1} Outputs the argument in huge text. \hy-10{421}{Huge:1} Outputs the argument in huger text that \hy-13{422}{huge}. \hy-10{424}{HUGE:1} Outputs the argument in huger text that \hy-13{425}{Huge}. \hy-10{427}{include:1} Include the given file. The command must not be preceded by any whitespace, and spurious whitespace between elements of the command will also trip up Tex2RTF. \hy-10{429}{indented:2} Environment supplied by Tex2RTF to allow (possibly nested) indentation of LaTeX and RTF text. The first argument is the amount to be indented. For example: \hy-14{430}{\begin{indented}{2cm} This text should be indented by a couple of centimetres. This can be useful to highlight paragraphs. \end{indented} } produces: This text should be indented by a couple of centimetres. This can be useful to highlight paragraphs. \hy-10{432}{input:1} Include the given file. The command must not be preceded by any whitespace, and spurious whitespace between elements of the command will also trip up Tex2RTF. \hy-10{434}{itemize:1} Indents each \hy-13{435}{item} of a list and precedes with a bullet. If the file \hy-14{436}{bullet.bmp} is found by Tex2RTF, this bitmap will be used as the bullet (WinHelp RTF); otherwise, a symbol or bold `o' will be used instead, depending on output format. Use \hy-13{437}{itemsep} to specify the separation between list items. Currently this only works for linear or WinHelp RTF output. If the value is more than zero, an extra paragraph is inserted. \hy-10{439}{item:0} Marks an item of a \hy-13{440}{itemize}, \hy-13{441}{description} or \hy-13{442}{enumerate} list. Items within a description environment should have an `optional' argument in square brackets which will be highlighted. \hy-10{444}{itemsep:0} Use this command to specify the separation between list items. Currently this only works for linear or WinHelp RTF output. If the value is zero, no extra paragraph is inserted; if the value is more than zero, an extra paragraph is inserted. \hy-10{446}{image:2} This is translated to a PSBOX macro package \hy-7{447}{psboxto} command in LaTeX, the first argument being a sizing command and the second a filename. In HTML mode, the second argument is used to generate a PostScript file reference. In RTF mode, the second argument is tried with first a BMP extension and then a WMF extension to find a suitable Windows bitmap file or placeable metafile. If a suitable file is found, in Windows Help mode a \hy-7{448}{bmc} command is inserted into the RTF file with a reference to the file. In linear RTF mode, the bitmap or metafile is converted into hex and inserted into the RTF document. Note that only RGB-encoded Windows bitmaps, or placeable metafiles, are valid for input to Tex2RTF. You can convert a RLE (run length encoded) bitmap file into a (bigger) RGB file using a program such as Paintshop Pro. A placeable metafile has a special header with dimension information. One may be constructed by a wxWindows program by calling the function wxMakeMetafilePlaceable. The Microsoft Windows SDK has a sample program that loads and steps through placeable and ordinary metafiles. Another wrinkle is that programs differ in the methods they use to recognise pictures in RTF files. You may need to use the \hy-7{449}{bitmapMethod} setting, which can be ``hex'' (embed the hex data in the file with a \dibitmap keyword), ``includepicture'' (use the MS Word 6.0 INCLUDEPICTURE field) or ``import'' (an earlier name for INCLUDEPICTURE). Here is an example of using the \hy-7{450}{image} command. \hy-14{451}{\begin{figure} $$\image{5cm;0cm}{heart.ps}$$ \caption{My picture}\label{piccy} \end{figure} } The dollars centre the image in the horizontal plane. The syntax of the first argument to \hy-7{452}{image} is taken from syntax used by the \hy-7{453}{psbox} package: it allows specification of the horizontal and vertical dimensions of the image. Scaling will take place for PostScript and metafile images. A value of zero indicates that the image should be scaled in proportion to the non-zero dimension. Zeros for both dimensions will leave the image unscaled in the case of metafiles, or scaled to fit the page in the case of PostScript. \hy-10{455}{index:1} In WinHelp mode, adds a keyword to the keyword list for the current topic. This keyword must currently be straight text, with no embedded commands. The conversion process must be run twice (without quitting Tex2RTF inbetween) to resolve the keyword references. \hy-10{457}{it:1} Marks the argument in italic. \hy-10{459}{label:1} Labels the chapter, section, subsection, subsubsection or figure caption with the given label. This must be an ASCII string, and duplicate items with different case letters are not allowed. The command must follow immediately after the section or caption command, with no intervening whitespace. \hy-10{461}{large:1} Marks the argument in large text. \hy-10{463}{Large:1} Makes the argument display in larger text than \hy-13{464}{large}. \hy-10{466}{LARGE:1} Makes the argument display in larger text than \hy-13{467}{Large}. \hy-10{469}{LaTeX:0} Outputs the annoying LaTeX upper and lower case name. \hy-10{471}{latexignore:1} Ignores the argument in LaTeX. \hy-10{473}{latexonly:1} Only prints the argument in LaTeX. \hy-10{475}{ldots} Outputs three dots. \hy-10{477}{maketitle} Makes the article or report title by outputting the \hy-13{478}{title}, \hy-13{479}{author} and optionally \hy-13{480}{date}. \hy-10{482}{marginparwidth:1} Specifies the width of a margin paragraph. \hy-10{484}{marginpar:1} Inserts a marginal note. It is best to use the Tex2RTF extensions \hy-13{485}{marginparodd} and \hy-13{486}{marginpareven} for best results. \hy-10{488}{marginpareven:1} Inserts a marginal note on even pages. This is required for RTF generation since it is impossible for Tex2RTF to know in advance which side of paper the marginal note will fall upon, and the text has to be positioned using absolute dimensions. If only one sided output is required, use \hy-13{489}{marginparodd} instead. \hy-10{491}{marginparodd:1} Inserts a marginal note on odd pages. This is required for RTF generation since it is impossible for Tex2RTF to know in advance which side of paper the marginal note will fall upon, and the text has to be positioned using absolute dimensions. Also, even if one-sided output is required, this command should be used instead of \hy-7{492}{marginpar} because the LaTeX macro allows it to be used just before a paragraph. Normally, if this were done, the marginal note would not be aligned with the paragraph succeeding it. For example: \hy-14{493}{\marginparodd{{\it Note:} if nothing happens, perhaps you have not plugged your computer in at the mains.}% To start using your WhizzyGig Computer 4001, push the Power button and wait for some kind of response. } Note the percent sign after the \hy-7{494}{marginparodd} command: without it, LaTeX refuses to believe that the following text is part of the same paragraph, and will print the note at the wrong place. You should use \hy-13{495}{textwidth} to allow space for marginal notes, and also \hy-13{496}{marginparwidth} to specify the size of the marginal note. In WinHelp, HTML and wxHelp, marginal notes are treated as normal text delineated with horizontal rules above and below. \hy-10{498}{membersection:1} Used when formatting C++ classes to print a subsection for the member name. \hy-10{500}{member:1} Used to format a C++ member variable name. \hy-10{502}{multicolumn:3} Used in \hy-13{503}{tabular} environment to denote a cell that spans more than one column. Only supplied for compatibility with existing LaTeX files, since all it does in RTF is output the correct number of cell commands, with the multicolumn text squashed into one cell. \hy-10{505}{newcommand:3} Define a new command; arguments are the command, the number of arguments, and the command body. For example: \hy-14{506}{\newcommand{\crazy}[2]{{\bf #1} is crazy but {\bf #2} is not.} } The command must have no whitespace at the start of the line or between the three arguments. New commands may also be defined in the \hy-14{507}{tex2rtf.ini} file using slightly different syntax (see \hy-13{508}{Macro not found error}). \hy-10{510}{newpage:0} Inserts a page break. \hy-10{512}{nocite:1} Specifies that this reference should appear in the bibliography, but the citation should not appear in the text. See also \hy-13{513}{cite}. \hy-10{515}{noindent:0} Sets paragraph indentation to zero. See also \hy-13{516}{parindent}. \hy-10{518}{normalbox:1} Draws a box around the given paragraph in LaTeX and RTF. In HTML and XLP formats, horizontal rules are drawn before and after the text. For example: \hy-14{519}{\normalbox{This should be a boxed paragraph for highlighting important information, such as information for registering a shareware program.} } gives: ---------------------------------------------------------------------- This should be a boxed paragraph for highlighting important information, such as information for registering a shareware program. ---------------------------------------------------------------------- See also \hy-13{520}{normalboxd} for double-bordered text. \hy-10{522}{normalboxd:1} Draws a double border around the given paragraph in LaTeX and RTF. In HTML and XLP formats, horizontal rules are drawn before and after the text. For example: \hy-14{523}{\normalboxd{This should be a boxed paragraph for highlighting important information, such as information for registering a shareware program.} } gives: ---------------------------------------------------------------------- This should be a boxed paragraph for highlighting important information,such as information for registering a shareware program. ---------------------------------------------------------------------- See also \hy-13{524}{normalbox} for single-bordered text. \hy-10{526}{normalsize:1} Sets the font size back to normal. \hy-10{528}{onecolumn:0} Sets the number of columns to one. LaTeX and linear RTF only. \hy-10{530}{pageref:1} In linear RTF, generates a page reference to the given label. \hy-10{532}{pagestyle:1} If argument is \hy-7{533}{fancyplain} or \hy-7{534}{fancy}, Tex2RTF separates the header from the rest of the page with a rule. This command must be defined for headers and footers to work properly. See also \hy-13{535}{setheader}, \hy-13{536}{setfooter}. LaTeX and linear RTF only. \hy-10{538}{pagenumbering:1} The argument may be one of: \hy-8{539}{alph} a, b, ... \hy-8{540}{Alph} A, B, ... \hy-8{541}{arabic} 1, 2, ... \hy-8{542}{roman} i, ii, ... \hy-8{543}{Roman} I, II, ... LaTeX and linear RTF only. \hy-10{545}{paragraph*} Behaves as for a subsubsection. \hy-10{547}{paragraph} Behaves as for a subsubsection. \hy-10{549}{param:1} Formats a C++ type and argument pair. Should be used within the third argument of a a \hy-13{550}{func} command. \hy-10{552}{parindent:1} Indents the first line of succeeding paragraphs by the given amount. \hy-10{554}{parskip:1} Changes the spacing between paragraphs. In fact, in RTF this will cause two \hy-13{555}{par} commands to be output if parindent is greater than zero. \hy-10{557}{par:0} Causes the paragraph to end at this point. LaTeX and Tex2RTF also treat two consecutive newlines as a paragraph break. \hy-10{559}{printindex} In linear RTF, inserts an index. \hy-10{561}{popref:2} Similar to \hy-13{562}{helprefn}, except that in Windows Help, the destination text is popped up in a small window to be dismissed with a mouse click, instead of going to a separate section. Currently this command can only refer to a labelled glossary entry; see \hy-13{563}{gloss}. \hy-10{565}{psboxto:2} Identical to \hy-13{566}{image}. \hy-10{568}{quote:1} Indents a short quotation. \hy-10{570}{quotation:1} Indents a long quotation. \hy-10{572}{ref:1} In LaTeX and linear RTF, refers to a \hy-13{573}{label} and causes the number of that section or figure to be printed. \hy-10{575}{rm:1} Causes the argument to be formatted in a plain, roman font. \hy-10{577}{row:1} A Tex2RTF command signifying the row of a table within the \hy-13{578}{tabular} environment. See also \hy-13{579}{ruledrow}. \hy-10{581}{ruledrow:1} A Tex2RTF command signifying a ruled row of a table within the \hy-13{582}{tabular} environment. See also \hy-13{583}{row}. \hy-10{585}{rtfignore:1} Ignores the argument in linear RTF. \hy-10{587}{rtfonly:1} Only outputs the argument in linear RTF. \hy-10{589}{rtfsp:0} Outputs a space in RTF. Tex2RTF tries to insert a space where one is implied by a newline, but cannot cope where a line starts or ends with a command, in the middle of a paragraph. Use this command to insert a space explicitly. \hy-10{591}{sc:1} Prints the output in small capitals. \hy-10{593}{section*:1} Section header, with no entry in the contents page. \hy-10{595}{section:1} Section header, with an entry in the contents page. \hy-10{597}{sectionheading:1} Like \hy-13{598}{section}, but does not increment the section number and does not print a section number in the printed documentation contents page, or in the section heading. \hy-10{600}{setfooter:6} Tex2RTF has a non-standard way of setting headers and footers, but the default macro definitions in texhelp.sty may be altered to your current method. The arguments are as follows: \hy-8{601}{1.} Left footer, even pages \hy-8{602}{2.} Centre footer, even pages \hy-8{603}{3.} Right footer, even pages \hy-8{604}{4.} Left footer, odd pages \hy-8{605}{5.} Centre footer, odd pages \hy-8{606}{6.} Right footer, odd pages For many documents, the first three arguments will be left empty. The behaviour for first pages of a chapter, section or document is to have a blank header, but print the footer. For best results, define headers and footers for \hy-7{607}{each chapter or section}. Note that this command works only for LaTeX and linear RTF. See also \hy-13{608}{setheader}. \hy-10{610}{setheader:6} Tex2RTF has a non-standard way of setting headers and footers, but the default macro definitions in texhelp.sty may be altered to your current method. The arguments are as follows: \hy-8{611}{1.} Left header, even pages \hy-8{612}{2.} Centre header, even pages \hy-8{613}{3.} Right header, even pages \hy-8{614}{4.} Left header, odd pages \hy-8{615}{5.} Centre header, odd pages \hy-8{616}{6.} Right header, odd pages For many documents, the first three arguments will be left empty. If \hy-13{617}{pagestyle} is not plain or empty, the header will separated from the rest of the page by a rule. The behaviour for first pages of a chapter, section or document is to have a blank header, but print the footer. For best results, define headers and footers for \hy-7{618}{each chapter or section}. Note that this command works only for LaTeX and linear RTF. See also \hy-13{619}{setfooter}. \hy-10{621}{shortcite:1} The same as \hy-13{622}{cite}. \hy-10{624}{small:1} Prints the argument in a small font. \hy-10{626}{special:1} Simply copies the argument to the output file without processing (except \} is translated to }, and \{ is translated to {, to allow for insertion of braces). \hy-10{628}{ss:0} Outputs the German sharp S character s. \hy-10{630}{subparagraph*:1} Behaves as for a subsubsection. \hy-10{632}{subparagraph:1} Behaves as for a subsubsection. \hy-10{634}{subsection*:1} Subsection header, with no entry in the contents page. \hy-10{636}{subsection:1} Subsection header, with an entry in the contents page. \hy-10{638}{subsubsection*:1} Subsubsection header, with no entry in the contents page. \hy-10{640}{subsubsection:1} Subsubsection header, with an entry in the contents page. \hy-10{642}{tabbing:1} Tabbing environment: doesn't work properly in RTF. \hy-10{644}{tableofcontents:0} Inserts the table of contents at this point. In linear RTF mode, a proper Word for Windows table of contents will be inserted unless the variable \hy-7{645}{insertTOC} is set to \hy-7{646}{false}. \hy-10{648}{tabular:2} Tabular environment: an attempt is made to output something reasonable in RTF format, although currently only simple tables will work. The first argument specifies the column formatting. a pipe symbol (|) denotes a vertical border, one of \hy-7{649}{l, r, c} signifies a normal column of default width, and \hy-7{650}{p} followed by a dimension specifies a column of given width. It is recommended that the \hy-7{651}{p} is used since Tex2RTF cannot deduce a column width in the same way that LaTeX can. Horizontal rules are achieved with \hy-13{652}{hline}; two together signify a double rule. Use the Tex2RTF \hy-13{653}{row} and \hy-13{654}{ruledrow} commands for best effect. For two-column tables that work in WinHelp files, use \hy-13{655}{twocollist} instead. Example: \hy-14{656}{\begin{tabular}{|l|p{8.5cm}|}\hline \row{{\bf A.I.}&{\bf Simulation}}\hline\hline \row{rules&constraints/methods} \row{planning&design of experiments} \row{diagnosis&analysis of results} \ruledrow{learning&detection of connections} \end{tabular} } This produces: \hy-14{657}{-------------------------------------------------------------------------------- \hy-8{658}{A.I.} \hy-8{659}{Simulation}---------------------------------------------------------------------------------------------------------------------------------------------------------------- rules constraints/methods planning design of experiments diagnosis analysis of results learning detection of connections } \hy-10{661}{TeX:0} Outputs the annoying TeX upper and lower case name. \hy-10{663}{textwidth:1} Sets the text width (valid for RTF only). This might be used in conjunction with \hy-13{664}{marginpar}, for example, to leave space for marginal notes. \hy-10{666}{thebibliography:1} An environment for specifying the a bibliography as a series of \hy-13{667}{bibitem} commands; the preferred method is to use .bib files and \hy-13{668}{bibliography} instead. \hy-10{670}{title:1} Sets the title, to be output when the command \hy-13{671}{maketitle} is used. \hy-10{673}{tiny:1} Prints the argument in a very small font. \hy-10{675}{today:0} Outputs today's date. \hy-10{677}{toocomplex:1} An environment for dealing with complex LaTeX commands that Tex2RTF cannot handle. In normal LaTeX, the argument will be output as normal. In Tex2RTF output, the argument will be output as verbatim text, for the user to hand-translate into the desired output format. See also \hy-13{678}{comment}. \hy-10{680}{tt:1} Outputs the argument in teletype font. \hy-10{682}{typeout:1} Outputs the text on the Tex2RTF text window. \hy-10{684}{twocolitem:2} Used to specify a row for a two column list, a Tex2RTF extension to optimize two-column lists for different file formats. See \hy-13{685}{twocollist}, \hy-13{686}{twocolitemruled}. \hy-10{688}{twocolitemruled:2} Used to specify a ruled row for a two column list, a Tex2RTF extension to optimize two-column lists for different file formats. See \hy-13{689}{twocollist}, \hy-13{690}{twocolitem}. \hy-10{692}{twocollist:1} A Tex2RTF environment for specifying a table of two columns, often used in manuals and help files (for example, for listing commands and their meanings). The first column should be one line only, and the second can be an arbitrary number of paragraphs. The reason that a normal tabular environment cannot be used is that WinHelp does not allow borders in table cells, so a different method must be employed if any of the rows are to be ruled. In LaTeX, a table is used to implement this environment. In RTF, indentation is used instead. Use this environment in conjunction with \hy-13{693}{twocolitem} and \hy-13{694}{twocolitemruled}. To set the widths of the first and second column, use \hy-13{695}{twocolwidtha} and \hy-13{696}{twocolwidthb}. Example: \hy-14{697}{\htmlignore{\begin{twocollist}} \twocolitemruled{{\bf Command}}{{\bf Description}} \twocolitem{File}{The file menu is used to select various file-related operations, such as saving, loading, exporting, importing, saving as and various other bits and pieces.} \twocolitem{Edit}{The Edit menu is used for selection, copying, pasting and various other bits and pieces.} \end{twocollist} } This produces: \hy-8{698}{Command} \hy-8{699}{Description} File The file menu is used to select various file-related operations, such as saving, loading, exporting, importing, saving as and various other bits and pieces. Edit The Edit menu is used for selection, copying, pasting and various other bits and pieces. \hy-10{701}{twocolwidtha:1} Sets the width of the first column in a two column list to the given dimension. See also \hy-13{702}{twocollist} and \hy-13{703}{twocolwidthb}. \hy-10{705}{twocolwidthb:1} Sets the width of the second column in a two column list to the given dimension. See also \hy-13{706}{twocollist} and \hy-13{707}{twocolwidtha}. \hy-10{709}{twocolumn:0} Sets the number of columns to two. LaTeX and linear RTF only. \hy-10{711}{underline:1} Underlines the argument. \hy-10{713}{verbatiminput:1} Include the given file as if it were within a \hy-13{714}{verbatim} environment. The command must not be preceded by any whitespace, and spurious whitespace between elements of the command will also trip up Tex2RTF. \hy-10{716}{verbatim:1} Uses a fixed-width font to format the argument without interpreting any LaTeX commands. \hy-10{718}{verb} The \hy-7{719}{verb} command is like the \hy-13{720}{verbatim} environment, but for small amounts of text. The syntax is: \hy-14{721}{\verb<char><text><char> } The character \hy-7{722}{char} is used as a delimiter; it may be any character not ocurring in the following text, except asterisk. For example, \verb$\thing%^&$ produces \thing%^&. \hy-10{724}{winhelpignore:1} Ignores the argument in WinHelp RTF. \hy-10{726}{winhelponly:1} Only outputs the argument in WinHelp RTF. \hy-10{728}{xlpignore:1} Ignores the argument in XLP mode (wxHelp files). \hy-10{730}{xlponly:1} Only outputs the argument in XLP mode (wxHelp files). \hy-10{756}{Macro not found} This error may indicate that Tex2RTF has not implemented a standard LaTeX macro, or that a local macro package is being used that Tex2RTF does not know about. It can cause spurious secondary errors, such as not recognising the end document command. You can get round this by defining a macro file (default name \hy-14{757}{tex2rtf.ini}) containing command definitions, such as: \hy-14{758}{\crazy [2]{{\bf #2} is crazy but #1 is not} \something [0]{} \julian [0]{Julian Smart} } New commands may be defined in LaTeX files, but custom macro files will have to be defined when local style files are being used. See \hy-13{759}{Initialisation file syntax} for further details. The `Macro not found' error can also be caused by a syntax error such as an unbalanced brace or passing the wrong number of arguments to a macro, so look in the vicinity of the reported error for the real cause. Here is one obscure situation that causes this error: \hy-14{760}{\begin{center} {\large{\underline{A}}} \end{center} } The problem is too many curly brackets. This should be rewritten as: \hy-14{761}{\begin{center} {\large \underline{A}} \end{center} } \hy-10{763}{Unresolved reference} References and citations are usually resolved on a second pass of Tex2RTF. If this doesn't work, then a missing label or bibliographical entry is to blame. \hy-10{765}{Output crashes the RTF reader} This could be due to confusing table syntax. Set 'compatibility ' to TRUE in .ini file; also check for end of row characters backslash characters on their own on a line, and insert correct number of ampersands for the number of columns. E.g. \hy-14{766}{hello & world\\ \\ } becomes \hy-14{767}{hello & world\\ &\\ } \hy-10{769}{Erratic list indentation} Try increasing the value of the variable \hy-7{770}{listItemIndent} (default 40 points) to give more space between label and following text. A global replace of \item [ to \item[ may also be helpful to remove unnecessary space before the item label. \hy-10{772}{Missing figure or section reference} Ensure all labels \hy-7{773}{directly} follow captions or sections (no intervening white space). \hy-10{775}{Unresolved references in Word for Windows} If question marks appear instead of numbers for figures and tables, select all (e.g. CTRL-A), then press F9 \hy-7{776}{twice} to reformat the document twice. For the second format, respond with \hy-7{777}{Update Entire Table} to any prompts. \hy-10{213}{General options} Option Description compatibility Set to true for maximum LaTeX compatibility, e.g. if tables crash RTF readers. Should be false (default) if the Tex2RTF guidelines are followed, e.g. use of \hy-7{214}{row} command in tabular environment. conversionMode One of RTF, WinHelp, XLP (or wxHelp), and HTML. ignoreInput Adds the filename to the list of files ignored by the \hy-7{215}{input} command. The only default filename in the list is \hy-14{216}{psbox.tex}. isInteractive If true, runs in interactive mode (the default). runTwice If true, runs the converter twice. \hy-10{218}{Presentation options} Option Description authorFontSize Specifies the point size for the author and date (RTF only). chapterFontSize Specifies the point size for chapter headings (RTF only). documentFontSize One of 10, 11 and 12, to specify the main font size independently of the LaTeX document style command. sectionFontSize Specifies the point size for section headings (RTF only). subsectionFontSize Specifies the point size for subsection headings (RTF only). titleFontSize Specifies the point size for the title (RTF only). chapterName The string used when referencing chapters. The default is ``chapter". sectionName The string used when referencing sections. The default is ``section". subsectionName The string used when referencing subsections. The default is ``subsection". subsubsectionName The string used when referencing subsubsections. The default is ``subsubsection". indexName The string used for printing the index heading. The default is ``Index". contentsName The string used for printing the contents heading. The default is ``Contents". tablesName The string used for printing the list of tables heading. The default is ``List of Tables". tableName The string used when referencing a table. The default is ``table". figuresName The string used for printing the list of figures heading. The default is ``List of Figures". figureName The string used when referencing a figure. The default is ``figure". glossaryName The string used for printing the glossary heading. The default is ``Glossary". referencesName The string used for printing the references heading. The default is ``References". \hy-10{220}{RTF/WinHelp options} Option Description bitmapMethod Can be ``hex'' (embed the hex data in the file with a \dibitmap keyword), ``includepicture'' (use the MS Word 6.0 INCLUDEPICTURE field) or ``import'' (an earlier name for INCLUDEPICTURE). ``hex'' may be used for importing into MS Works, but this doesn't work for Word 6.0. The default is ``includepicture''. defaultColumnWidth The width in points for columns in tables where the width of the column is not set by using \hy-7{221}{p} in the tabular argument. The default is 100. footerRule If true, draws a rule above footers (linear RTF only). generateHPJ If true, generates a .HPJ project file (WinHelp mode only). headerRule If true, draws a rule below headers (linear RTF only). listLabelIndent Specifies the size of list item label indentation, in points. The default is 18. listItemIndent Specifies the size of list item indentation, in points. The default is 40. indexSubsections If true (the default), subsection and subsubsection titles are indexed in RTF mode. mirrorMargins If true, margins are mirrored in twosided documents (linear RTF only). useWord If true (the default), Word for Windows RTF formatting is used where possibly, e.g. for the table of contents, list of tables, and list of figures. useHeadingStyles If true (the default), sections are marked with appropriate heading styles for generating the table of contents in RTF. useUpButton If true (the default), WinHelp files will be generated with an \hy-8{222}{Up} button to make browsing easier. Note that you need to put an extra line in the CONFIG section of your .HPJ file: \hy-14{223}{CreateButton("Up", "&Up", "JumpId(`name.hlp', `Contents')")} where \hy-14{224}{name.hlp} is the name of your help file. winHelpTitle Windows Help file title, inserted into the project file if \hy-8{225}{generateHPJ} is true. \hy-10{227}{HTML options} Option Description htmlBrowseButtons Allows generation of Contents, Up, browse back and browse forward buttons on each HTML page except title page. Specify none, text or bitmap. If you specify bitmap, make sure that the files contents.gif, up.gif, back.gif and forward.gif are in the directory where the HTML files will reside: samples are given in the docs directory. \hyindex{ "WXHELPCONTENTS" 4 5 6 7 12 13 17 18 21 22 26 27 31 32 49 50 51 52 56 57 62 63 66 67 70 71 73 74 78 79 155 156 162 163 164 165 173 174 178 179 183 184 188 189 200 201 210 211 212 213 217 218 219 220 226 227 228 229 237 238 240 241 243 244 250 251 254 255 259 260 265 266 267 268 269 270 271 272 274 275 276 277 280 281 282 283 287 288 289 290 292 293 296 297 298 299 300 301 302 303 304 305 306 307 308 309 312 313 314 315 316 317 318 319 320 321 323 324 325 326 328 329 331 332 337 338 340 341 345 346 347 348 349 350 352 353 357 358 359 360 361 362 363 364 367 368 372 373 375 376 378 379 386 387 389 390 391 392 393 394 395 396 397 398 399 400 404 405 407 408 411 412 414 415 416 417 418 419 420 421 423 424 426 427 428 429 431 432 433 434 438 439 443 444 445 446 454 455 456 457 458 459 460 461 462 463 465 466 468 469 470 471 472 473 474 475 476 477 481 482 483 484 487 488 490 491 497 498 499 500 501 502 504 505 509 510 511 512 514 515 517 518 521 522 525 526 527 528 529 530 531 532 537 538 544 545 546 547 548 549 551 552 553 554 556 557 558 559 560 561 564 565 567 568 569 570 571 572 574 575 576 577 580 581 584 585 586 587 588 589 590 591 592 593 594 595 596 597 599 600 609 610 620 621 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 647 648 660 661 662 663 665 666 669 670 672 673 674 675 676 677 679 680 681 682 683 684 687 688 691 692 700 701 704 705 708 709 710 711 712 713 715 716 717 718 723 724 725 726 727 728 729 730 731 732 739 740 741 742 753 754 755 756 762 763 764 765 768 769 771 772 774 775 778 779 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 8 797 8 797 9 803 9 803 11 807 11 807 19 805 19 805 20 795 20 795 42 52 42 52 43 459 43 459 44 400 44 400 45 405 45 405 46 561 46 561 48 201 48 201 55 557 55 557 158 400 158 400 159 459 159 459 167 290 167 290 175 387 175 387 176 379 176 379 177 561 177 561 181 455 181 455 182 455 182 455 195 756 195 756 278 332 278 332 279 353 279 353 285 666 285 666 286 290 286 290 291 165 291 165 294 358 294 358 295 459 295 459 310 307 310 307 311 174 311 174 322 677 322 677 327 319 327 319 330 477 330 477 335 353 335 353 336 277 336 277 339 439 339 439 343 307 343 307 344 595 344 595 351 439 351 439 355 332 355 332 356 277 356 277 365 368 365 368 366 561 366 561 369 364 369 364 370 364 370 364 371 561 371 561 374 376 374 376 377 373 377 373 380 439 380 439 381 338 381 338 382 593 382 593 383 400 383 400 384 561 384 561 388 379 388 379 401 405 401 405 406 400 406 400 409 648 409 648 410 581 410 581 422 419 422 419 425 421 425 421 435 439 435 439 437 444 437 444 440 434 440 434 441 338 441 338 442 350 442 350 464 461 464 461 467 463 467 463 478 670 478 670 479 272 479 272 480 329 480 329 485 491 485 491 486 488 486 488 489 491 489 491 495 663 495 663 496 482 496 482 503 648 503 648 508 756 508 756 513 315 513 315 516 552 516 552 520 522 520 522 524 518 524 518 535 610 535 610 536 600 536 600 550 376 550 376 555 557 555 557 562 405 562 405 563 379 563 379 566 446 566 446 573 459 573 459 578 648 578 648 579 581 579 581 582 648 582 648 583 577 583 577 598 595 598 595 608 610 608 610 617 532 617 532 619 600 619 600 622 315 622 315 652 408 652 408 653 577 653 577 654 581 654 581 655 692 655 692 664 484 664 484 667 283 667 283 668 290 668 290 671 477 671 477 678 321 678 321 685 692 685 692 686 688 686 688 689 692 689 692 690 684 690 684 693 684 693 684 694 688 694 688 695 701 695 701 696 705 696 705 702 692 702 692 703 705 703 705 706 692 706 692 707 701 707 701 714 716 714 716 720 716 720 716 759 201 759 201 8 797 8 797 9 803 9 803 11 807 11 807 19 805 19 805 20 795 20 795 42 52 42 52 43 459 43 459 44 400 44 400 45 405 45 405 46 561 46 561 48 201 48 201 55 557 55 557 158 400 158 400 159 459 159 459 167 290 167 290 175 387 175 387 176 379 176 379 177 561 177 561 181 455 181 455 182 455 182 455 195 756 195 756 278 332 278 332 279 353 279 353 285 666 285 666 286 290 286 290 291 165 291 165 294 358 294 358 295 459 295 459 310 307 310 307 311 174 311 174 322 677 322 677 327 319 327 319 330 477 330 477 335 353 335 353 336 277 336 277 339 439 339 439 343 307 343 307 344 595 344 595 351 439 351 439 355 332 355 332 356 277 356 277 365 368 365 368 366 561 366 561 369 364 369 364 370 364 370 364 371 561 371 561 374 376 374 376 377 373 377 373 380 439 380 439 381 338 381 338 382 593 382 593 383 400 383 400 384 561 384 561 388 379 388 379 401 405 401 405 406 400 406 400 409 648 409 648 410 581 410 581 422 419 422 419 425 421 425 421 435 439 435 439 437 444 437 444 440 434 440 434 441 338 441 338 442 350 442 350 464 461 464 461 467 463 467 463 478 670 478 670 479 272 479 272 480 329 480 329 485 491 485 491 486 488 486 488 489 491 489 491 495 663 495 663 496 482 496 482 503 648 503 648 508 756 508 756 513 315 513 315 516 552 516 552 520 522 520 522 524 518 524 518 535 610 535 610 536 600 536 600 550 376 550 376 555 557 555 557 562 405 562 405 563 379 563 379 566 446 566 446 573 459 573 459 578 648 578 648 579 581 579 581 582 648 582 648 583 577 583 577 598 595 598 595 608 610 608 610 617 532 617 532 619 600 619 600 622 315 622 315 652 408 652 408 653 577 653 577 654 581 654 581 655 692 655 692 664 484 664 484 667 283 667 283 668 290 668 290 671 477 671 477 678 321 678 321 685 692 685 692 686 688 686 688 689 692 689 692 690 684 690 684 693 684 693 684 694 688 694 688 695 701 695 701 696 705 696 705 702 692 702 692 703 705 703 705 706 692 706 692 707 701 707 701 714 716 714 716 720 716 720 716 759 201 759 201 } 
